org.springframework.http.codec

Class ServerSentEvent.BuilderImpl<T>

java.lang.Object

org.springframework.http.codec.ServerSentEvent.BuilderImpl<T>

All Implemented Interfaces:

ServerSentEvent.Builder<T>

Enclosing class:

ServerSentEvent<T>

private static class ServerSentEvent.BuilderImpl<T>
extends java.lang.Object
implements ServerSentEvent.Builder<T>

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	comment
private T	data
private java.lang.String	event
private java.lang.String	id
private java.time.Duration	retry

Constructor Summary

Constructors

Constructor and Description
BuilderImpl()
BuilderImpl(T data)

Method Summary

Modifier and Type	Method and Description
ServerSentEvent<T>	build() Builds the event.
ServerSentEvent.Builder<T>	comment(java.lang.String comment) Set SSE comment.
ServerSentEvent.Builder<T>	data(T data) Set the value of the data field.
ServerSentEvent.Builder<T>	event(java.lang.String event) Set the value of the event field.
ServerSentEvent.Builder<T>	id(java.lang.String id) Set the value of the id field.
ServerSentEvent.Builder<T>	retry(java.time.Duration retry) Set the value of the retry field.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

id

@Nullable
private java.lang.String id

event

@Nullable
private java.lang.String event

retry

@Nullable
private java.time.Duration retry

comment

@Nullable
private java.lang.String comment

data

@Nullable
private T data

Constructor Detail

BuilderImpl

public BuilderImpl()

BuilderImpl

public BuilderImpl(T data)

Method Detail

id

public ServerSentEvent.Builder<T> id(java.lang.String id)

Description copied from interface: ServerSentEvent.Builder

Set the value of the id field.

Specified by:

id in interface ServerSentEvent.Builder<T>

Parameters:

id - the value of the id field

Returns:

this builder

event

public ServerSentEvent.Builder<T> event(java.lang.String event)

Description copied from interface: ServerSentEvent.Builder

Set the value of the event field.

Specified by:

event in interface ServerSentEvent.Builder<T>

Parameters:

event - the value of the event field

Returns:

this builder

retry

public ServerSentEvent.Builder<T> retry(java.time.Duration retry)

Description copied from interface: ServerSentEvent.Builder

Set the value of the retry field.

Specified by:

retry in interface ServerSentEvent.Builder<T>

Parameters:

retry - the value of the retry field

Returns:

this builder

comment

public ServerSentEvent.Builder<T> comment(java.lang.String comment)

Description copied from interface: ServerSentEvent.Builder

Set SSE comment. If a multi-line comment is provided, it will be turned into multiple SSE comment lines as defined in Server-Sent Events W3C recommendation.

Specified by:

comment in interface ServerSentEvent.Builder<T>

Parameters:

comment - the comment to set

Returns:

this builder

data

public ServerSentEvent.Builder<T> data(@Nullable
                                       T data)

Description copied from interface: ServerSentEvent.Builder

Set the value of the data field. If the data argument is a multi-line String, it will be turned into multiple data field lines as defined in the Server-Sent Events W3C recommendation. If data is not a String, it will be encoded into JSON.

Specified by:

data in interface ServerSentEvent.Builder<T>

Parameters:

data - the value of the data field

Returns:

this builder

build

public ServerSentEvent<T> build()

Description copied from interface: ServerSentEvent.Builder

Builds the event.

Specified by:

build in interface ServerSentEvent.Builder<T>

Returns:

the built event